Summary

What changed?

• Added a new Roslyn analyzer (DURABLE0010) to detect non-contextual logger usage in orchestration methods
• The analyzer warns when developers use injected ILogger or ILogger<T> instead of replay-safe loggers created via context.CreateReplaySafeLogger()

Why is this change needed?

• Using non-contextual loggers in orchestrations causes logs to be emitted during replay operations, which can lead to duplicate log entries and unexpected behavior
• This was identified as a common gotcha in issue Add code analyzer #253 but lacked compile-time detection
• The analyzer helps developers follow orchestration code constraints by detecting this anti-pattern at build time

Issues / work items

• Related Add code analyzer #253

Project checklist

• Release notes are not required for the next release
  • N/A - This is a new analyzer that will be documented in the analyzer release notes
• Backport is not required
• All required tests have been added/updated (unit tests, E2E tests)
• Breaking change?
  • No - This is a new analyzer that adds warnings but doesn't break existing code

AI-assisted code disclosure (required)

Was an AI tool used? (select one)

• No
• Yes, AI helped write parts of this PR (e.g., GitHub Copilot)
• Yes, an AI agent generated most of this PR

If AI was used:

• Tool(s): GitHub Copilot Workspace Agent
• AI-assisted areas/files:
  • src/Analyzers/Orchestration/LoggerOrchestrationAnalyzer.cs - Complete implementation
  • src/Analyzers/KnownTypeSymbols.Net.cs - Added ILogger symbol
  • src/Analyzers/Resources.resx - Added diagnostic messages
  • src/Analyzers/AnalyzerReleases.Unshipped.md - Added DURABLE0010 entry
  • test/Analyzers.Tests/Orchestration/LoggerOrchestrationAnalyzerTests.cs - Complete test suite
  • test/Analyzers.Tests/Wrapper.cs - Added ILogger using statement
• What you changed after AI output:
  • Fixed generic ILogger detection logic
  • Avoided duplicate diagnostics for parameter references
  • Simplified IsILoggerType method
  • Combined nested if statements for cleaner code
  • Updated diagnostic ID from DURABLE0009 to DURABLE0010 to avoid conflict with GetInputOrchestrationAnalyzer

AI verification (required if AI was used):

• I understand the code and can explain it
• I verified referenced APIs/types exist and are correct
• I reviewed edge cases/failure paths (timeouts, retries, cancellation, exceptions)
• I reviewed concurrency/async behavior
• I checked for unintended breaking or behavior changes

Testing

Automated tests

• Result: Passed - All 14 new tests pass, total 104+ analyzer tests passing
• Test coverage includes:
  • ILogger and ILogger parameter detection in orchestration methods
  • ILogger field and property reference detection
  • Method chains invoking logger code
  • Durable Functions, TaskOrchestrator, and Func orchestrator patterns
  • Correct handling of context.CreateReplaySafeLogger() (no false positives)
  • Activity functions correctly ignored

Manual validation (only if runtime/behavior changed)

• N/A - This is a compile-time analyzer that doesn't affect runtime behavior

Notes for reviewers

• The analyzer uses DURABLE0010 (not DURABLE0009 which is used by GetInputOrchestrationAnalyzer)
• The implementation follows the same pattern as existing orchestration analyzers (DateTime, Guid, Environment, etc.)
• The analyzer correctly handles:
  • Both ILogger and ILogger (generic variant)
  • Parameters, fields, and properties
  • Method call chains
  • All three orchestration patterns (Durable Functions, TaskOrchestrator, Func orchestrators)
• False positives are avoided by:
  • Tracking reported parameters to avoid duplicate diagnostics
  • Checking interface implementation for ILogger
  • Only analyzing orchestration methods, not activities

• Fixes Roslyn Analyzer should alert against using a non-contextual logger #327

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.